home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2004 April / Gamestar_61_2004-04_dvdb.iso / DVDStar / Editace / hltp.exe / {app} / Applications / Overview Description Generator / Readme.txt < prev   
Text File  |  2002-05-21  |  7KB  |  134 lines
  1. Overview Description Generator for Half-Life v0.1b
  2. --------------------------------------------------
  3.  
  4. What it does:
  5. -------------
  6. This little program makes textfiles to go with your overview pictures from Half-Life maps.
  7. You can enter your data manually or import a condump file and let the program search for the
  8. necessary values.
  9.  
  10. Requirements:
  11. -------------
  12. I assume you already know how to make your overviews. If not, you should read a tutorial on the
  13. internet about how to make overviews first. After that, you'll understand what the purpose of the
  14. textfiles this program makes is, and the program will be pretty self-explanitory. Also note that
  15. you need at least 800x600 pixels screen resolution.
  16.  
  17. Instructions:
  18. -------------
  19. The data needed for the textfiles consists of several values. You can find these in your condump
  20. after you have made one as explained in tutorials on the internet. (I added the file aliases.txt
  21. to this utility, which contains aliases that can help you by making the creation condumps and
  22. screen- or snapshots easier and faster.)
  23.  
  24. The info needed is in lines that look like this:
  25.  
  26.  Overview: Zoom 2.25, Map Origin (512.00, 45.50, 496.00), Z Min 1057.00, Z Max -65.00, Rotated 1
  27.  
  28. You need the following data values (the values from my example are noted in brackets):
  29.  
  30. * Zoom (2.25)
  31. * Origin coordinate 1 (512.00)
  32. * Origin coordinate 2 (45.50)
  33. * Z Max (-65)
  34. * Rotated (1)
  35.  
  36. You also need to know if you want to use a .bmp or .tga picture.
  37.  
  38. There are two ways to make your textfiles: from manual input or from reading a condump from the
  39. game. I'll give a short explanation of both ways.
  40.  
  41. 1) MAKING A TEXTFILE FROM MANUAL INPUT
  42.  
  43. * Fill in all the values on the left side of the screen as explained above. See the
  44.   'Special notes' section of this document for info on the 'Add to ZMax' value!
  45. * Check/uncheck the rotated switch.
  46. * Choose the file format of the overview picture you want to use (bmp/tga).
  47. * Also enter the FILENAME of the map (without .bsp).
  48. * In the 'File preview' window you can see what your textfile will look like. Now you can save it
  49.   with the 'Save' or 'Save as' button or save it from the 'File' menu.
  50.  
  51. 2) MAKING A TEXTFILE FROM READING A CONDUMP
  52.  
  53. This is where it gets fun:
  54. * Press the 'Open condump' button to choose a file to open. It's now displayed in the
  55.   'Opened condump' window.
  56. * Next, you can press the 'Search values' button. The program now takes the values from the FIRST
  57.   line it encounters that has the values in it and fills out the boxes for you. If you want to
  58.   use another line from the file instead of the first one, just remove the lines in your
  59.   'Opened condump' window that come before the one you want to use. And then press the
  60.   'Search values' button. (You most likely want to use the line with the lowest value for Zmax).
  61.   Note that error trapping does not work perfectly (yet) when importing from invalid condumps.
  62.   So always check the imported data before saving. The best way to do that is to TAB through all
  63.   data entry fields until none of them returns an error.
  64. * Choose the file format of the overview picture you want to use (bmp/tga).
  65. * Choose another 'Add to ZMax' value if desired.  See the 'Special notes'
  66.   section of this document for info on the 'Add to ZMax' value!
  67. * Also enter the FILENAME of the map (without .bsp)
  68.  
  69. * In the 'File preview' window you can see what your textfile will look like. Now you can save it
  70.   with the 'Save' or 'Save as' button or save it from the 'File' menu.
  71.  
  72. The Menus
  73. ---------
  74.  
  75. 'File' menu    : Open condump  = Displays a dialog box where you can open a condump textfile.
  76.                  Search Values = Search for the necessary values in your opened condump textfile.
  77.                  Save          = Makes a quick save to the default path (as set in the 'Options'
  78.                                  menu). This overwrites an existing file.
  79.                  Save as       = Displays a dialog box where you can choose the location and
  80.                                  filename you want to save to.
  81.                  Exit          = Exits the program.
  82.  
  83. 'Options' menu : Set SAVE path = Sets the default path to save to. If you use the 'Save' option
  84.                                  the file is saved to this location with the mapname as filename.
  85.                                  No questions are asked. It's also the path that gets displayed
  86.                                  by default in the 'Save as' dialog box.
  87.  
  88. 'Help' menu    : Readme = Displays this help file
  89.                  About  = Displays a short info about the program and my E-Mail address
  90.  
  91. Special notes
  92. -------------
  93. * About the 'Add to ZMax' setting:
  94.   If you make multiple screenshots to make your overview from, make sure you know the ZMax value
  95.   of the LOWEST floor players can walk on, and use this one to generate the textfile!
  96.   
  97.   Explanation:
  98.   The overview in Half-Life uses the same coordinate system as the map itself. The ZMAx value
  99.   sets the height position (z-axis) of your overview picture ingame. If you want the player logos
  100.   in your overview window (The red and blue pictures) to be visible, these must be placed higher
  101.   than the overview picture of course. That's why you need to know the ZMax value of the LOWEST
  102.   floor a player can stand on and use this one for the textfile. This program then takes the
  103.   ZMax value and adds the value in 'Add to ZMax' to it, then writes it to the file. By default
  104.   this adds 1 unit to the ZMax value and thus places the logos 1 unit above the floor at the
  105.   lowest point where the player can stand. Now the higher the player stands, the longer the
  106.   yellow 'pole' underneath the player is drawn. So increasing this value makes the yellow 'poles'
  107.   underneath the logos get longer, but it could make the readability of the overview worse.
  108.  
  109.   If you use a ZMax value that's too high, e.g. the height of a floor in the middle between your
  110.   highest and lowest floor, then in about half of your map the logos will be drawn underneath the
  111.   overview and thus they are not visible! You would have to do a trial and error increasing the
  112.   'Add to ZMax' value until you've found the correct value to have your logos shown everywhere in
  113.   the map.
  114.  
  115.   If you use a ZMax value that's too low, then even on the lowest floor you'll see very long
  116.   poles. Now imagine the pole length for the highest floor the player can walk on! That makes the
  117.   readability of the overview very bad.
  118.  
  119. * Be sure to check out the file aliases.txt that comes with this utility. It contains aliases
  120.   that can help you by making the creation condumps and screen- or snapshots easier and faster.
  121.  
  122. * Half-Life is copyrighted ⌐ by Valve Software. Special thanks go out to the Valve team
  123.   for making this great game. Visit them at www.valvesoftware.com.
  124.  
  125.  
  126. Made by --- Zest --- in May 2002
  127.  
  128. Found a bug? Got suggestions? Mail me: zest.96@12move.nl
  129. This utility can be downloaded from http://home.12move.nl/~sh297397
  130.  
  131. This utility is FREEWARE. You may distribute it freely only if no modications are made to any
  132. of the files, and nothing is added or removed. You may not distribute this utility commercially
  133. in any way without prior written permission from me.
  134.